Skip to content

feat: mcp server docs#3043

Open
Kawron wants to merge 4 commits into
feat/mcp-feature-branchfrom
feat/mcp-server-docs
Open

feat: mcp server docs#3043
Kawron wants to merge 4 commits into
feat/mcp-feature-branchfrom
feat/mcp-server-docs

Conversation

@Kawron
Copy link
Copy Markdown
Collaborator

@Kawron Kawron commented Apr 24, 2026

Documentation page for MCP server

@ajasnosz ajasnosz changed the title Feat/mcp server docs feat: mcp server docs May 4, 2026
Comment thread docs/mcp_server/index.md Outdated
Comment thread docs/mcp_server/index.md Outdated
Comment thread docs/mcp_server/index.md Outdated
Comment thread docs/mcp_server/index.md Outdated
Comment on lines +38 to +51
```
+-----------------+ stdio / SSE +------------------+
| MCP client | <--------------------> | SC4S MCP server |
| (AI assistant) | | (container) |
+-----------------+ +---------+--------+
|
HTTP |
v
+------------------+
| SC4S container |
| (syslog-ng + |
| REST API) |
+------------------+
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will it be better generated as boxes on github pages? If not, can we use draw.io to create an image and add it here?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it will be rendered as code block. I just like this minimal ASCII diagrams, but I can change it to draw.io diagram so it will look more professional

Comment thread docs/mcp_server/index.md Outdated
Comment on lines +34 to +51
## Build the image

The Dockerfile is part of the SC4S repository. Build from the repository
root so that the `docs/`, `package/lite/etc/addons/`, and
`.agents/skills/parser-creator/` directories are available to the build
context.

Docker:

```bash
docker build -t sc4s-mcp -f sc4s_mcp/Dockerfile .
```

Podman:

```bash
podman build -t sc4s-mcp -f sc4s_mcp/Dockerfile .
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd write the steps based on the fact that we would probably be relesing that as build container in the future, instad of the instruction to clone and build it

Copy link
Copy Markdown
Collaborator Author

@Kawron Kawron May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, but maybe until it's released let's keep it that way. Maybe it can be useful for developers

Comment thread docs/mcp_server/tools.md Outdated
Comment thread docs/mcp_server/tools.md Outdated
Comment thread docs/mcp_server/resources_and_prompts.md Outdated
Comment thread docs/mcp_server/installation.md
@Kawron Kawron requested a review from ajasnosz May 4, 2026 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants